Transfer Methods

The following endpoints are use to manage and retrieve the transfer methods on the system.

  • DELETE /transfer-methods/:id

  • GET /transfer-methods/:id

  • GET /transfer-methods

  • POST /transfer-methods

Introduction

This API provides transfer method management functionalities.

Transfer methods

Transfer method entity model

Remove a transfer method

DELETE /transfer-methods/:id

Delete transfer method by id.

Response Options

400 Bad Request

  • validation_failed

    • If id is invalid.

404 Not Found

  • transfer_method_not_found

204 OK

Request example:

DELETE <hostname>/transfer-methods/e7941059-74c6-4b3f-b029-d3aa03d1ea44

Get a transfer method

GET /transfer-methods/:id

Get transfer method by id.

Response Options

400 Bad Request

  • validation_failed

    • If id is invalid.

404 Not Found

  • transfer_method_not_found

200 OK

Request example:

GET <hostname>/transfer-methods/e7941059-74c6-4b3f-b029-d3aa03d1ea44

Response example:

{
  "data": {
    "appId": "e7941059-74c6-4b3f-b029-d3aa03d1ea44",
    "createdAt": "2020-10-28T17:40:55.501Z",
    "deletedAt": null,
    "externalReference": null,
    "id": "e7941059-74c6-4b3f-b029-d3aa03d1ea44",
    "identityId": "e7941059-74c6-4b3f-b029-d3aa03d1ea44",
    "metadata": {
      "bankName": "Royal bank",
      "swiftCode": "BKBKESMMXXX",
      "bankAccountName": "foobar",
      "bankAccountNumber": "GB94BARC10201530093459"
    },
    "type": "internationalWire",
    "updatedAt": "2020-10-28T17:40:55.501Z"
  }
}

Get all transfer methods

GET /transfer-methods

Get transfer methods list.

Available filters

Available sorts

Paginate options

Response Options

200 OK

Request example:

GET <hostname>/transfer-methods

Response example:

{
  "data": [{
    "appId": "e7941059-74c6-4b3f-b029-d3aa03d1ea44",
    "createdAt": "2020-10-28T17:40:55.501Z",
    "deletedAt": null,
    "externalReference": null,
    "id": "e7941059-74c6-4b3f-b029-d3aa03d1ea44",
    "identityId": "e7941059-74c6-4b3f-b029-d3aa03d1ea44",
    "metadata": {
      "bankName": "Royal bank",
      "swiftCode": "BKBKESMMXXX",
      "bankAccountName": "foobar",
      "bankAccountNumber": "GB94BARC10201530093459"
    },
    "type": "internationalWire",
    "updatedAt": "2020-10-28T17:40:55.501Z"
  }],
  "total": 1
}

Create a new transfer method

POST /transfer-methods

Creates a transfer method.

Request Parameters

Body parameters for type internationalWire

Body parameters for type wire

Body parameters for type ach

Body parameters for type pix

Response Options

400 Bad Request

  • validation_failed

    • If the required parameters are not provided.

    • If additional parameters are provided.

    • If some of the parameters type is invalid.

    • If some of the parameters constraints is not respected.

200 OK

Request example:

POST <hostname>/transfer-methods

{
  "bankAccountName": "foobar",
  "bankAccountNumber": "GB94BARC10201530093459",
  "bankName": "Royal bank",
  "identityId": "87e5d63a-c92a-4f2f-a869-bb7119d0f0a0",
  "swiftCode": "BKBKESMMXXX" ,
  "type": "internationalWire"
}

Response example:

{
  "data": {
    "appId": "e86755c5-f997-443e-992c-67f2866278aa",
    "createdAt": "2022-06-09T18:08:27.604Z",
    "deletedAt": null,
    "externalReference": "76559632-442a-4a78-89e3-b4960cf0cd73",
    "id": "8471e769-5bc3-4531-a320-bdcab1ceea50",
    "identityId": "87e5d63a-c92a-4f2f-a869-bb7119d0f0a0",
    "metadata": {
      "bankName": "Royal bank",
      "swiftCode": "BKBKESMMXXX",
      "bankAccountName": "foobar",
      "bankAccountNumber": "GB94BARC10201530093459"
    },
    "type": "internationalWire",
    "updatedAt": "2022-06-09T18:08:29.211Z"
  }
}

Last updated