Open Banking API
Create a domestic payment
api
post
/domestic-payments

Create a domestic payment

Create a domestic 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​

Domestic Payment Created

HTTP Headers
HTTP Headers
Response body
Body object 
Was this page helpful?
POST
/domestic-payments . 
Parameters
curl -L -X POST 'https://oba-auth.revolut.com/domestic-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": "ec62477b-xxxx-41e2-xxxx-4d760c425a3e",
    "Initiation": {
      "InstructionIdentification": "ID412",
      "EndToEndIdentification": "E2E123",
      "InstructedAmount": {
        "Amount": "10.0",
        "Currency": "GBP"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "11223321325698",
        "Name": "Receiver Co."
      },
      "RemittanceInformation": {
        "Unstructured": "Shipment fee"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "EcommerceGoods",
    "MerchantCategoryCode": "5967",
    "MerchantCustomerIdentification": "1238808123123",
    "DeliveryAddress": {
      "AddressLine": [
        "7"
      ],
      "StreetName": "Apple Street",
      "BuildingNumber": "1",
      "PostCode": "E2 7AA",
      "TownName": "London",
      "Country": "UK"
    }
  }
}'
Request body samples
{
  "Data": {
    "ConsentId": "ec62477b-xxxx-41e2-xxxx-4d760c425a3e",
    "Initiation": {
      "InstructionIdentification": "ID412",
      "EndToEndIdentification": "E2E123",
      "InstructedAmount": {
        "Amount": "10.0",
        "Currency": "GBP"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "11223321325698",
        "Name": "Receiver Co."
      },
      "RemittanceInformation": {
        "Unstructured": "Shipment fee"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "EcommerceGoods",
    "MerchantCategoryCode": "5967",
    "MerchantCustomerIdentification": "1238808123123",
    "DeliveryAddress": {
      "AddressLine": [
        "7"
      ],
      "StreetName": "Apple Street",
      "BuildingNumber": "1",
      "PostCode": "E2 7AA",
      "TownName": "London",
      "Country": "UK"
    }
  }
}
Response body samples
{
  "Data": {
    "ConsentId": "ec62477b-xxxx-41e2-xxxx-4d760c425a3e",
    "CreationDateTime": "2022-09-23T14:57:45.899155Z",
    "DomesticPaymentId": "632dc969-xxxx-ae29-xxxx-50cefc4ceae7",
    "Initiation": {
      "CreditorAccount": {
        "Identification": "11223321325698",
        "Name": "Receiver Co.",
        "SchemeName": "UK.OBIE.SortCodeAccountNumber"
      },
      "EndToEndIdentification": "E2E123",
      "InstructedAmount": {
        "Amount": "10.0",
        "Currency": "GBP"
      },
      "InstructionIdentification": "ID412",
      "RemittanceInformation": {
        "Unstructured": "Shipment fee"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.IBAN",
        "Identification": "GB95REVO00997053872360",
        "Name": "John Doe"
      }
    },
    "Status": "Pending",
    "StatusUpdateDateTime": "2022-09-23T14:57:45.899155Z"
  },
  "Links": {
    "Self": "https://oba-auth.revolut.com/domestic-payments/632dc969-xxxx-ae29-xxxx-50cefc4ceae7"
  },
  "Meta": {
    "TotalPages": 1
  }
}