Last Updated: 09 July 2025 | Change Log

Safetypay

SafetyPay is a non-card payment method using the large bank network in Latin America that enables online cash payments, bank transfers and cross-border transactions for a global market of customers.

Note

Make yourself familiar with our API Principles to ensure a resilient integration.

Product overview

Feature summary

Payment type	Country	Acceptance Currency	Recurring	Reversals	Partial Reversals
Bank Transfer	Brazil, Mexico, Peru	USD, EUR*	❌	❌	❌

SafetyPay displays the corresponding local currency amount to your customer. If the authorization currency (USD or EUR) and the local currency are different, SafetyPay applies an FX (Foreign Exchange) margin to this currency conversion.

Minimum Transaction Value: 1.00 USD
Maximum Transaction Value: 5.000 USD or EUR equivalent

Get started

Get started using our API Reference and set your headers.

Request

POST https://try.access.worldpay.com/apmPayments

Example request

application/json

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "safetypay",
    "value": {
      "amount": 1900,
      "currency": "EUR"
    },
    "narrative": {
      "line1": "Joe Plumbing Ltd"
    },
    "paymentInstrument": {
      "type": "direct",
      "country": "BR"
    },
    "resultUrls": {
      "pending": "https://worldpay.com/pending",
      "success": "https://worldpay.com/success",
      "cancel": "https://worldpay.com/cancel"
    },
    "customer": {
      "email": "shopper@worldpay.com"
    }
  }
}

Parameters

transactionReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required

merchantobject(MerchantV2)required

merchant.entitystring[ 3 .. 32 ] characters^([a-zA-Z0-9\- ]*)$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"

instructionobject(InstructionV2)required

Object that contains the payment type and details.

instruction.methodstringrequired

Type of payment method

Value"alipay_cn"

Discriminator

instruction.valueobject(Value)required

The value of the payment.

instruction.value.amountinteger(int64)[ 1 .. 2147483647 ]required

The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.

Example: 12

instruction.value.currencystringrequired

The supported ISO 4217 currency codes.

Enum"AED""AFN""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD"

instruction.narrativeobject(NarrativeBase)required

instruction.narrative.line1string[ 1 .. 24 ] characters^[a-zA-Z0-9-., ]*$required

The description shown on your customer's bank statement for the payment.

Example: "MindPalace"

instruction.paymentInstrumentobject(AlipayCnInstrumentV2)required

instruction.paymentInstrument.typestringrequired

Type of instruction

Value"direct"

instruction.paymentInstrument.languagestring

Your customer's language.

Enum"aa""ab""ae""af""ak""am""an""ar""as""av"

instruction.resultUrlsobject(ResultUrlsAlipay)required

instruction.resultUrls.cancelstring

The URL your customer is redirected to, after a cancelled payment outcome.

Example: "https://worldpay.com/cancel"

instruction.resultUrls.failurestringrequired

The URL your customer is redirected to, after a failed payment outcome.

Example: "https://worldpay.com/failure"

instruction.resultUrls.pendingstringrequired

The URL your customer is redirected to, after a pending payment outcome.

Example: "https://worldpay.com/pending"

instruction.resultUrls.successstringrequired

The URL your customer is redirected to, after a successful payment outcome.

Example: "https://worldpay.com/success"

instruction.deviceDataobject(DeviceData)

instruction.customerobject(CustomerWithName)

Response

Successful request response

an HTTP code 201
a paymentId which is unique to the payment - we recommend storing the "id", as you can use it to manage the payment later
a url to redirect your customer to the APM provider to complete the payment
a link to query the payment status
an object which will give flow information such as method (e.g. safetypay) and type (direct)
a commandId generated by us identifying a single merchant interaction (e.g. cmdYNdIHBPJwbkjLiykzTx0)

Example response

{
  "paymentInstrument": {
    "method": "safetypay",
    "type": "direct"
  },
  "paymentId": "eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTzojxnTb6gzLpYifu+gD3nPAaFT9PiiV:KsP+z2Cdr9oxuSfqYOtdVF0OwjHRCY6fWf5XZUPFYfD4fs2JzaCZKV3L7DQm7JfXl6rjXA0ubX6hJpY5kUX4Djm9+PFFKUS69z2nX5zwzYPSSVDUYtLDOZ6R0m0fuRrvkt3IoyOFqIWhKM2Ks:rlczHJ2DGe1:xPRqjBWEQYSfjhGO0ig5hWkDRl9fGV4F+Ts5DIzFBZXwnIUMyUbZMpJ0fOD9XAPga+EJnSR3UaE8kYYgR1TxL5XUxKsWCP0oxXTQ26dg1mH8uA==",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try-access.worldpay.com/apmPayments/eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTzojxnTb6gzLpYifu+gD3nPAaFT9PiiV:KsP+z2Cdr9oxuSfqYOtdVF0OwjHRCY6fWf5XZUPFYfD4fs2JzaCZKV3L7DQm7JfXl6rjXA0ubX6hJpY5kUX4Djm9+PFFKUS69z2nX5zwzYPSSVDUYtLDOZ6R0m0fuRrvkt3IoyOFqIWhKM2Ks:rlczHJ2DGe1:xPRqjBWEQYSfjhGO0ig5hWkDRl9fGV4F+Ts5DIzFBZXwnIUMyUbZMpJ0fOD9XAPga+EJnSR3UaE8kYYgR1TxL5XUxKsWCP0oxXTQ26dg1mH8uA=="
    }
  },
  "_actions": {},
  "redirect": "http://secure-test.worldpay.com/redirect?tokenId=62a8645c-f481-4880-9ed8-e80d67153ae2",
  "commandId": "cmdmZ4I3ZW19OhrjDrGs7vpG0"
}

Errors

Check out our API reference for the full error code schema.

Next steps

Manage your Safetypay payment