Open Banking API
Create an international payment
api
post
/international-payments

Create an international payment

Create an international payment.

note

As is defined in the Open Banking Specifications, the /Data/Initiation and the /Data/Risk sections of the request must be an exact match for the related consent passed in ConsentId.

See also Tutorials: Initiate your first payment.

Request​

Default

Header Parameters
Header Parameters
Request body
Body object 

Response​

International Payments Created

HTTP Headers
HTTP Headers
Response body
Body object 
Was this page helpful?
POST
/international-payments . 
Parameters
curl -L -X POST 'https://oba-auth.revolut.com/international-payments' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-jws-signature: <API_KEY_VALUE>' \
-H 'Authorization: Bearer <yourSecretApiKey>' \
--data-raw '{
  "Data": {
    "ConsentId": "65067c5d-e752-410d-a922-c9da2aeb8e6b",
    "Initiation": {
      "InstructionIdentification": "Reference1234",
      "EndToEndIdentification": "E2E1234",
      "CurrencyOfTransfer": "EUR",
      "InstructedAmount": {
        "Amount": "10.0",
        "Currency": "EUR"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "11223321325698",
        "Name": "Receiver Co."
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment"
  }
}'
Request body samples
{
  "Data": {
    "ConsentId": "65067c5d-e752-410d-a922-c9da2aeb8e6b",
    "Initiation": {
      "InstructionIdentification": "Reference1234",
      "EndToEndIdentification": "E2E1234",
      "CurrencyOfTransfer": "EUR",
      "InstructedAmount": {
        "Amount": "10.0",
        "Currency": "EUR"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "11223321325698",
        "Name": "Receiver Co."
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment"
  }
}
Response body samples
{
  "Data": {
    "ConsentId": "2373df19-xxxx-43a9-xxxx-b5fd14e5920f",
    "CreationDateTime": "2022-09-26T09:29:10.152499Z",
    "Initiation": {
      "CreditorAccount": {
        "Identification": "11223321325698",
        "Name": "Receiver Co.",
        "SchemeName": "UK.OBIE.SortCodeAccountNumber"
      },
      "CurrencyOfTransfer": "GBP",
      "EndToEndIdentification": "E2E1234",
      "InstructedAmount": {
        "Amount": "10.0",
        "Currency": "GBP"
      },
      "InstructionIdentification": "Reference1234",
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.IBAN",
        "Identification": "GB95REVO00997053872360",
        "Name": "John Doe"
      }
    },
    "InternationalPaymentId": "633170e6-xxxx-xxxx-xxxx-e90e7f88abee",
    "Status": "Pending",
    "StatusUpdateDateTime": "2022-09-26T09:29:10.152499Z"
  },
  "Links": {
    "Self": "https://oba-auth.revolut.com/international-payments/633170e6-xxxx-xxxx-xxxx-e90e7f88abee"
  },
  "Meta": {
    "TotalPages": 1
  }
}