# /transaction/create

## Purpose
Creates a new outbound cross-border money transfer and registers it in the ViaBlocks platform.

This request defines the sender, beneficiary, transaction details (amounts, currencies, destination), and the selected funding method.

## When to use
Use this endpoint to initiate a new transaction when you are ready to submit:
- Sender onboarding details (KYC/AML fields)
- Beneficiary details and payout configuration
- Origination and delivery amounts/currencies
- Funding configuration (cash or remote payment)

## What happens next
Next steps depend on the funding method:
- Cash funding: Transaction may proceed directly into processing (partner-dependent).
- Remote payment funding: Transaction is created in a pending funding state. The sender must complete payment remotely and the transaction will not proceed until funding and risk/compliance review are completed.

## Authentication
Requires x-client-id and x-secret-key headers.

## Notes
- Request validation is enforced for formats, allowed values, corridor rules, and compliance requirements.
- For the remote payment flow, refer to: ../guides/remotepayment.md

## Common errors
- 400 Validation errors (missing/invalid fields)
- 401 Invalid credentials
- 404 Sender/beneficiary linkage issues (when applicable)
- 422 Business-rule rejection (e.g., credit limit)
- 500 Internal error

Endpoint: POST /transaction/create
Version: 1.0.0

## Header parameters:

  - `x-client-id` (string, required)
    Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request.

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004
    Example: "string"

  - `x-secret-key` (string, required)
    Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential.

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004
    Example: "string"

## Request fields (application/json):

  - `sender` (object, required)
    Contains the personal and identification information of the transaction sender.

 All fields are subject to AML, KYC, and compliance validation rules. 

This information is used to verify the identity of the person initiating the transaction and to evaluate regulatory and risk requirements.

Error codes: required=400001, type=400002

  - `sender.firstName` (string, required)
    Sender’s given (first) name as it appears on their official identification document. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `sender.middleName` (string)
    Sender’s middle name, if applicable. Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.lastName` (string, required)
    Sender’s primary family name (surname). Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `sender.secondLastName` (string)
    Sender’s second family name, used in some countries. Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.phone` (string, required)
    Sender’s phone number without country code. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `sender.phoneCountryCode` (string, required)
    International dialing code of the sender’s phone number Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "+1"

  - `sender.email` (string, required)
    Sender’s email address used for notifications and transaction updates. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, format=400005

  - `sender.addressStreet` (string, required)
    Sender address. Structure: [Description, city name, State ISO2 zipCode, Country ISO3]. Example:'54545 Salo Rd, Hancock, MI 49930, USA' Regular expression: ^[0-9]+\s[\w\s.,-]+$ Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009

  - `sender.addressState` (string, required)
    Sender state (ISO 2).  https://en.wikipedia.org/wiki/ISO_3166-2 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "US-AL", "US-AK", "US-AZ", "US-AR", "US-CA", "US-CO", "US-CT", "US-DE", "US-FL", "US-GA", "US-HI", "US-ID", "US-IL", "US-IN", "US-IA", "US-KS", "US-KY", "US-LA", "US-ME", "US-MD", "US-MA", "US-MI", "US-MN", "US-MS", "US-MO", "US-MT", "US-NE", "US-NV", "US-NH", "US-NJ", "US-NM", "US-NY", "US-NC", "US-ND", "US-OH", "US-OK", "US-OR", "US-PA", "US-RI", "US-SC", "US-SD", "US-TN", "US-TX", "US-UT", "US-VT", "US-VA", "US-WA", "US-WV", "US-WI", "US-WY"

  - `sender.addressCity` (string, required)
    City name of the sender’s residence. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `sender.addressCountry` (string, required)
    Sender country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "USA"

  - `sender.addressZipCode` (string, required)
    Postal or ZIP code of the sender’s address. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `sender.documentType` (string)
    You can check the types of documents available according to your document country in our catalogs API    [Catalogs Endpoint Identifications](/apis/outbound/catalogs/paths/~1catalogs~1countries~1%7Bidcountry%7D~1identifications/get)  or review the following table with standard document types  Type of identification document provided by the sender (e.g., Passport, National ID).  

Document types (documentType) — click to expandCodeDocument TypeDescriptionBDBORDER CROSSING CARDBorder crossing card used to enter certain countries without a passport.BFCPF/CNPJBrazilian tax registry for individuals (CPF) and legal entities (CNPJ).CACARTEIRA DE IDENTIDADEIdentity document issued in Brazil.CCCÉDULA CIUDADANÍAIdentification document in Colombia.CECÉDULA DE IDENTIDAD Y ELECTORALIdentity document used in the Dominican Republic.CICÉDULA DE IDENTIDADIdentity document issued in various Latin American countries.CLCREDENCIAL DE ELECTORVoter identification document used in Mexico.CNCERTIFICATE OF NATURALIZATIONNaturalization certificate that grants citizenship in the U.S. or other countries.CPCADASTRO DE PESSOAS FÍSICAS (CPF)Tax registry for individuals in Brazil.CRCREW LANDING PERMIT & BADGELanding permit for aircraft crew members.CVCÉDULA DE VECINDADIdentity document in Guatemala.CZCERTIFICATE OF CITIZENSHIPCitizenship certificate issued by national governments.DIDOCUMENTO NACIONAL DE IDENTIDAD (DNI)Identity document in Argentina, Spain, and other countries.DLDRIVER'S LICENSEDriver's license.DNDOCUMENTO NACIONALNational identity document.DUDOCUMENTO ÚNICO DE IDENTIDAD (DUI)Identity document in El Salvador.EAEMPLOYMENT AUTHORIZATIONEmployment authorization document in the U.S.GCGREEN CARDPermanent residence card in the U.S.GIGOVERNMENT IDENTIFICATIONIdentification issued by the government for its citizens.ICCÉDULA DE IDENTIDAD CIVILCivil identity document in several countries.IDIDENTIFICATION CARDGeneral identification card.LDDRIVER'S LICENSEDriver's license.LELIBRETA ELECTORALElectoral document in Peru.LPLEARNER PERMITLearner's permit for driving.MCMATRÍCULA CONSULARIdentity document issued by consulates to citizens abroad.MIMILITARY IDMilitary identification.NNNONENo identity document required.OIOFFICIAL ID (POLICE, FIRE, ETC)Official identification for police, firefighters, etc.OTOTHEROther type of identity document.PAPASSPORTPassport issued by a government.PCPASSPORT CARDPassport card used in the U.S. for certain international travel.PPPASAPORTEPassport.PRPERMANENT RESIDENT CARDPermanent residence card in some countries.RARESIDENT ALIENDocument for a foreign resident.SISTATE ISSUED IDIdentification issued by a state or province.SSSSNSocial Security Number (U.S.).TITARJETA DE IDENTIDADIdentity card in some Latin American countries.TRTARJETA DE REGISTRO CONSULARConsular registration card for citizens abroad.VIVISAEntry visa for a country.

Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.documentDescription` (string)
    Human-readable description of the identification document. Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.documentNumber` (string)
    Identification document number. Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.documentExpirationDate` (string)
    Expiration date of the identification document. Format: YYYY-MM-DD Error codes: type=400002, minLength=400003, maxLength=400004, format=400005

  - `sender.documentCountry` (string)
    Sender country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.dateOfBirth` (string, required)
    Sender’s date of birth, used for identity verification and compliance checks. Format: YYYY-MM-DD Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, format=400005

  - `sender.ssnNumber` (string)
    The individual’s Social Security Number (SSN), a nine-digit numeric identifier issued in the United States for tax reporting, employment, and official identification purposes. Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.industry` (number)
    Unique identifier referencing the industry classification assigned to the entity, as defined in the organization’s official, property or key "id" in our catalogs API  \  [Catalogs Endpoint Industry](/apis/outbound/catalogs/paths/~1catalogs~1industry/get) Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.job` (number)
    Unique identifier representing the specific job or position assigned to the individual, as defined in the organization’s official job catalog, property or key "jobs" It contains a list of items with the "id" property in our catalogs API  \  [Catalogs Endpoint Industry](/apis/outbound/catalogs/paths/~1catalogs~1industry/get) Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.occupation` (string)
    Sender’s occupation or professional activity, This refers to the name of our list of available jobs based on the industry you select It contains a list of items with the "name" property. in our catalogs API  \  [Catalogs Endpoint Industry](/apis/outbound/catalogs/paths/~1catalogs~1industry/get) Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.employer` (string)
    Legal name of the organization or individual that employs the person, as registered for official, tax, and administrative purposes. Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.employerPhone` (string)
    Primary contact phone number of the employer, including country and area code, used for official communication and verification purposes.. Error codes: type=400002, minLength=400003, maxLength=400004

  - `sender.proofOfIncome` (string)
    Description of the sender’s source of income or supporting documentation. Error codes: type=400002, minLength=400003, maxLength=400004

  - `beneficiary` (object, required)
    Represents the final recipient of the funds in a cross-border transaction.

 Contains the personal, identification, and location information required to validate the recipient against AML, sanctions, and regulatory screening rules.

 This object is used to ensure the payout can be legally and operationally executed in the destination country.

Error codes: required=400001, type=400002

  - `beneficiary.firstName` (string, required)
    Beneficiary’s given name. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `beneficiary.middleName` (string)
    Beneficiary’s middle name, if applicable. Error codes: type=400002, minLength=400003, maxLength=400004

  - `beneficiary.lastName` (string, required)
    Beneficiary’s primary family name. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `beneficiary.secondLastName` (string)
    Beneficiary’s second family name. Error codes: type=400002, minLength=400003, maxLength=400004

  - `beneficiary.phone` (string, required)
    Beneficiary’s phone number without country code. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `beneficiary.phoneCountryCode` (string, required)
    International dialing code of the beneficiary’s phone number. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "+57"

  - `beneficiary.addressStreet` (string, required)
    Beneficiary address. Structure: [Description, city name, State ISO2 zipCode, Country ISO3]. Example:'54545 Salo Rd, Hancock, MI 49930, USA' Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `beneficiary.addressState` (string, required)
    Beneficiary state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010

  - `beneficiary.addressCity` (string, required)
    City name  of residence of the beneficiary. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `beneficiary.addressCountry` (string, required)
    Beneficiary country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010

  - `beneficiary.addressZipCode` (string)
    Postal or ZIP code of the beneficiary’s address. Error codes: type=400002, minLength=400003, maxLength=400004

  - `beneficiary.documentType` (string)
    You can check the types of documents available according to your document country in our catalogs API   [Catalogs Endpoint Identifications](/apis/outbound/catalogs/paths/~1catalogs~1countries~1%7Bidcountry%7D~1identifications/get)  or review the following table with standard document types  Type of identification document of the beneficiary.  

Document types (documentType) — click to expandCodeDocument TypeDescriptionBDBORDER CROSSING CARDBorder crossing card used to enter certain countries without a passport.BFCPF/CNPJBrazilian tax registry for individuals (CPF) and legal entities (CNPJ).CACARTEIRA DE IDENTIDADEIdentity document issued in Brazil.CCCÉDULA CIUDADANÍAIdentification document in Colombia.CECÉDULA DE IDENTIDAD Y ELECTORALIdentity document used in the Dominican Republic.CICÉDULA DE IDENTIDADIdentity document issued in various Latin American countries.CLCREDENCIAL DE ELECTORVoter identification document used in Mexico.CNCERTIFICATE OF NATURALIZATIONNaturalization certificate that grants citizenship in the U.S. or other countries.CPCADASTRO DE PESSOAS FÍSICAS (CPF)Tax registry for individuals in Brazil.CRCREW LANDING PERMIT & BADGELanding permit for aircraft crew members.CVCÉDULA DE VECINDADIdentity document in Guatemala.CZCERTIFICATE OF CITIZENSHIPCitizenship certificate issued by national governments.DIDOCUMENTO NACIONAL DE IDENTIDAD (DNI)Identity document in Argentina, Spain, and other countries.DLDRIVER'S LICENSEDriver's license.DNDOCUMENTO NACIONALNational identity document.DUDOCUMENTO ÚNICO DE IDENTIDAD (DUI)Identity document in El Salvador.EAEMPLOYMENT AUTHORIZATIONEmployment authorization document in the U.S.GCGREEN CARDPermanent residence card in the U.S.GIGOVERNMENT IDENTIFICATIONIdentification issued by the government for its citizens.ICCÉDULA DE IDENTIDAD CIVILCivil identity document in several countries.IDIDENTIFICATION CARDGeneral identification card.LDDRIVER'S LICENSEDriver's license.LELIBRETA ELECTORALElectoral document in Peru.LPLEARNER PERMITLearner's permit for driving.MCMATRÍCULA CONSULARIdentity document issued by consulates to citizens abroad.MIMILITARY IDMilitary identification.NNNONENo identity document required.OIOFFICIAL ID (POLICE, FIRE, ETC)Official identification for police, firefighters, etc.OTOTHEROther type of identity document.PAPASSPORTPassport issued by a government.PCPASSPORT CARDPassport card used in the U.S. for certain international travel.PPPASAPORTEPassport.PRPERMANENT RESIDENT CARDPermanent residence card in some countries.RARESIDENT ALIENDocument for a foreign resident.SISTATE ISSUED IDIdentification issued by a state or province.SSSSNSocial Security Number (U.S.).TITARJETA DE IDENTIDADIdentity card in some Latin American countries.TRTARJETA DE REGISTRO CONSULARConsular registration card for citizens abroad.VIVISAEntry visa for a country.

Error codes: type=400002, minLength=400003, maxLength=400004

  - `beneficiary.documentNumber` (string)
    Identification document number of the beneficiary. Error codes: type=400002, minLength=400003, maxLength=400004

  - `beneficiary.documentDescription` (string)
    Identification document number of the beneficiary. Error codes: type=400002, minLength=400003, maxLength=400004

  - `beneficiary.documentCountry` (string)
    Country that issued the beneficiary’s identification document. Error codes: type=400002, minLength=400003, maxLength=400004

  - `beneficiary.relationShip` (string)
    Relationship between sender and beneficiary (e.g., Family, Friend, Business). Error codes: type=400002, minLength=400003, maxLength=400004

  - `transactionInformation` (object, required)
    Represents the financial, operational, and processing configuration of the transaction.
Contains all parameters required to calculate, validate, route, and execute the transfer, including amounts, currencies, delivery method, funding source, fees, and payout instructions.
All fields are validated against business rules, compliance policies, and operational constraints before the transaction is accepted for processing.
Error codes: required=400001, type=400002

  - `transactionInformation.deliveryMode` (string, required)
    Defines the payout execution method and destination details for the transaction.

Specifies how and where the funds will be delivered to the beneficiary (e.g., cash pickup, bank deposit, walletcredit, or home delivery), including all routing and operational parameters required to complete the payout.

 Delivery mode     Code Delivery Mode Description     P Cash Pickup Cash withdrawal at an authorized location.   C Bank Deposit Direct deposit to a bank account.   O Mobile Wallet Deposit to a mobile wallet.   D Home Delivery Cash delivered to the recipient’s address.   U Undefined Undefined   

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "O", "C", "P", "D", "U"

  - `transactionInformation.deliveryModeDetails` (object, required)
    Contains the bank account and routing information required to execute the payout to the beneficiary.
This object defines the destination financial institution and account where the funds will be deposited, including account number, account type, routing number, and bank details.
All fields are validated against country-specific banking rules and payout network requirements before the transaction is released for payment.
Error codes: required=400001, type=400002

  - `transactionInformation.deliveryModeDetails.accountNumber` (string)
    Destination account number. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `transactionInformation.deliveryModeDetails.accountAuxiliaryField` (string)
    Error codes: type=400002, minLength=400003, maxLength=400004

  - `transactionInformation.deliveryModeDetails.accountType` (string)
    Delivery mode used for the transaction.Account typesCodeAccount TypeDescriptionSSavingSavings accountCCheckingChecking accountUUndefinedUndefined Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "S", "C", "U"

  - `transactionInformation.deliveryModeDetails.routingNumber` (string)
    Bank routing or clearing number Error codes: type=400002, minLength=400003, maxLength=400004

  - `transactionInformation.deliveryModeDetails.bank` (string)
    Name of the receiving bank. Error codes: type=400002, minLength=400003, maxLength=400004

  - `transactionInformation.funding` (object)
    Defines the source of funds and funding method used to initiate the transaction. Contains the payment instrument and funding configuration (e.g., cash, debit card, bank account, wallet), and is used to validate, authorize, and register the financial charge before the transaction is processed. Error codes: type=400002

  - `transactionInformation.funding.type` (string)
    Funding source type (e.g., bank account, cash, etc.). 

 Funding types    Code Funding Type Description     A Account bank Indicates that the transaction is funded directly from a bank account. The funds will be debited from the specified bank account using the configured banking or payment network before the transaction is processed.   C Cash Indicates that the transaction is funded using cash. The sender provides the funds in cash at an authorized agent location or branch before the transaction is processed.   

Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "A", "C", "U"

  - `transactionInformation.funding.accountNumber` (string)
    Funding account number. Error codes: type=400002, minLength=400003, maxLength=400004

  - `transactionInformation.funding.routingNumber` (string)
    Routing number bank. Error codes: type=400002, minLength=400003, maxLength=400004

  - `transactionInformation.originationCountryISO` (string, required)
    Origin country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "USA"

  - `transactionInformation.originationStateISO` (string, required)
    Origin state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "US-AL", "US-AK", "US-AZ", "US-AR", "US-CA", "US-CO", "US-CT", "US-DE", "US-FL", "US-GA", "US-HI", "US-ID", "US-IL", "US-IN", "US-IA", "US-KS", "US-KY", "US-LA", "US-ME", "US-MD", "US-MA", "US-MI", "US-MN", "US-MS", "US-MO", "US-MT", "US-NE", "US-NV", "US-NH", "US-NJ", "US-NM", "US-NY", "US-NC", "US-ND", "US-OH", "US-OK", "US-OR", "US-PA", "US-RI", "US-SC", "US-SD", "US-TN", "US-TX", "US-UT", "US-VT", "US-VA", "US-WA", "US-WV", "US-WI", "US-WY"

  - `transactionInformation.originationLocationCity` (string, required)
    City where the transaction is initiated. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `transactionInformation.originationAmount` (number, required)
    Amount of money sent in the origination currency. Error codes: required=400001, type=400002, minimum=400006, decimal=400008

  - `transactionInformation.originationCurrencyISO` (string, required)
    Origin currency (ISO). https://en.wikipedia.org/wiki/ISO_4217 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "USD"

  - `transactionInformation.exchangeRate` (number, required)
    Amount of money sent in the origination currency. Error codes: required=400001, type=400002, minimum=400006, decimal=400008

  - `transactionInformation.fee` (number, required)
    Transaction service fee charged for processing the remittance. Error codes: required=400001, type=400002, minimum=400006, decimal=400008

  - `transactionInformation.deliveryCountryISO` (string, required)
    Delivery country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010

  - `transactionInformation.deliveryStateISO` (string, required)
    Delivery state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010

  - `transactionInformation.deliveryAmount` (number, required)
    Amount to be delivered in the destination currency. Error codes: required=400001, type=400002, minimum=400006, decimal=400008

  - `transactionInformation.deliveryAmountCurrencyISO` (string, required)
    Delivery currency (ISO). https://en.wikipedia.org/wiki/ISO_4217 Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010

  - `transactionInformation.deliveryLocationCode` (string, required)
    Identifier of the delivery location selected from the list provided by our API catalog.  The value must correspond to the idPayer key of the selected item in the catalog response. in our catalogs API  [Catalogs Endpoint payouts](/apis/outbound/catalogs/paths/~1catalogs~1countries~1%7bidcountry%7d~1deliver-methods~1%7biddelivery%7d~1payouts/get)
Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010

  - `transactionInformation.deliveryLocationNetwork` (string, required)
    Identifier of the delivery network associated with the selected delivery location.  This value is filtered based on the deliveryLocationCode and must correspond  to the PaymentLocationCode key of the matching item in the API catalog response. [Catalogs Endpoint payouts](/apis/outbound/catalogs/paths/~1catalogs~1countries~1%7bidcountry%7d~1deliver-methods~1%7biddelivery%7d~1payouts~1%7bidpayout%7d~1locations/get)
Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010

  - `transactionInformation.deliveryLocationName` (string, required)
    Name of the delivery location associated with the selected delivery location.  This value is filtered based on the deliveryLocationCode and must correspond to the PaymentLocationName key of the matching item in the API catalog response. [Catalogs Endpoint payouts](/apis/outbound/catalogs/paths/~1catalogs~1countries~1%7bidcountry%7d~1deliver-methods~1%7biddelivery%7d~1payouts~1%7bidpayout%7d~1locations/get)
Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010

  - `transactionInformation.deliveryLocationCity` (string, required)
    City where the funds will be delivered. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `transactionInformation.sourceOfFounds` (string)
    Declared source of funds used to finance the remittance (e.g., salary, savings, business income). This information may be required for compliance (KYC/AML) depending on the client configuration, corridor, or transaction amount thresholds. Identifier representing the origin of the funds, selected from the list provided by the  [Catalogs Endpoint funds origin](/apis/outbound/catalogs/paths/~1catalogs~1funds-origin/get) API endpoint.  The value must correspond to the id key of the selected item in the catalog response. Error codes: type=400002, minLength=400003, maxLength=400004

  - `transactionInformation.remittancePurpose` (string)
    Declared purpose of the remittance, describing why the funds are being sent (e.g., family support, education, medical expenses, rent, personal transfer). This can be used for compliance classification, reporting, and corridor-specific regulatory requirements. Identifier representing the purpose of the remittance, selected from the corresponding catalog provided by the API.  The value must match the id key of the selected item in the catalog response. [Catalogs Endpoint wire purpose](/apis/outbound/catalogs/paths/~1catalogs~1wire-purpose/get) API endpoint.  Error codes: type=400002, minLength=400003, maxLength=400004

  - `channel` (string, required)
    Identifies the integration channel used to create the transaction (API, Web, Messaging, etc.). Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010
    Enum: "API", "WHATSAPP"

  - `channelMetadata` (object)
    Dynamic / Data considered relevant by the client for informational purposes for internal tracking Error codes: type=400002

## Response 200 fields (application/json):

  - `status` (string)
    Request status (success, error, etc.).

  - `message` (string)
    Descriptive message about the operation result.

  - `transaction_id` (string)
    Unique identifier of the generated transaction.

  - `transaction_uuid` (string)
    Unique identifier of the generated transaction.

  - `status_track_url` (string)
    URL where the user can track the transaction.

  - `folio` (string)
    Money transfer tracking number (optional)

  - `total_receiver` (string)
    Amount in destin currency that the customer is sending plus fees (optional)

  - `total_pay_receiver` (string)
    Amount in destination currency that the beneficiary is receiving (optional)

  - `rate` (string)
    Exchange rate (optional).

  - `source_currency_amount` (string)
    Amount in source currency that the customer is sending (optional).

  - `payment_url` (string)
    URL where the user can complete the payment (optional)

## Response 400 fields (application/json):

  - `errors` (array)
    List of object errorsError catalog for 400 (click to expand)CodeDescription400000The body of the request is required. Invalid JSON format of the request body.400415The routing number 'routingNumber' is not valid.

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)

## Response 401 fields (application/json):

  - `errors` (array)
    List of object errorsError catalog for 401 (click to expand)CodeDescription401000Invalid credentials

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)

## Response 404 fields (application/json):

  - `errors` (array)
    List of object errorsError catalog for 404 (click to expand)CodeDescription404001Sender not found404002Beneficiary does not belong to this sender

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)

## Response 422 fields (application/json):

  - `errors` (array)
    List of object errorsError catalog for 422 (click to expand)CodeDescription422001The agency credit limit has been exceeded or is insufficient to process this transaction.422002The service is temporarily unable to process transactions with the origination currency.422003Viamericas is unable to process a transaction for this customer/beneficiary

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)

## Response 500 fields (application/json):

  - `errors` (array)
    List of object errorsError catalog for 500 (click to expand)CodeDescription500000Internal Error500001Sender creation failed500002Beneficiary creation failed500003Transaction creation failed500004Payment link creation failed500005Compliance engine validation failed

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)