POST/transactions/bank-details

Bank Details

Looks up bank details using a SWIFT/BIC code or routing number.

Headers

FieldTypeRequiredPossible valuesDescription
session-tokenstringRequired

SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

FieldTypeRequiredPossible valuesDescription
fieldstringRequiredswift | routing

Field type to look up by.

codestringRequired

SWIFT/BIC or routing number code.

transferTypestringOptionalINTERNATIONAL_WIRE | WIRE | ACH | CROSS_BORDER_AED_DOMESTIC | CROSS_BORDER_AED_WIRE | CROSS_BORDER_ARS_DOMESTIC | CROSS_BORDER_BRL_DOMESTIC | CROSS_BORDER_CAD_DOMESTIC | CROSS_BORDER_CAD_WIRE | CROSS_BORDER_SEPA | CROSS_BORDER_EUR_WIRE | CROSS_BORDER_FASTER_PAYMENTS | CROSS_BORDER_GBP_WIRE | CROSS_BORDER_HKD_DOMESTIC | CROSS_BORDER_HKD_WIREY | CROSS_BORDER_JPY_DOMESTIC | CROSS_BORDER_JPY_WIRE | CROSS_BORDER_CLABE | CROSS_BORDER_MXN_WIRE | CROSS_BORDER_SGD_DOMESTIC | CROSS_BORDER_SGD_WIRE | CROSS_BORDER_ZAR_DOMESTIC | CROSS_BORDER_ZAR_WIRE

Payment type context.

Example request

{
  "field": "swift",
  "code": "BNMXMXMMXXX",
  "transferType": "INTERNATIONAL_WIRE"
}

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 301 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 503

API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).

ResponseMessagestringSuccess | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity

Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.

ResponseDataobjectPlease refer to below example for response body

Bank details matching the provided code.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Id": "-4104013677640372405",
    "RoutingNumber": "",
    "SwiftCode": "BNMXMXMMXXX",
    "RoutingNumberType": "swift",
    "BankName": "BANCO NACIONAL DE MEXICO S.A.",
    "BankAddress": {
      "AddressLine1": "Roberto Medellin No 800",
      "Location": "Mexico City",
      "Region": "CMX",
      "CountryCode": "",
      "CountryName": "MEXICO"
    },
    "FedACHRoutingNumber": "",
    "FedWireRoutingNumber": "",
    "SupportedPaymentTypes": [
      "wire"
    ]
  }
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose