Thunes Money Transfer API

https://docs.thunes.com/money-transfer/v2/
Admin
Thunes Money Transfer API is a REST-based gateway that facilitates global money transfers across...
Tokens:151,517
Snippets:489
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Pagination Example for API Resources

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Illustrates how to fetch paginated API resources using GET requests. It includes example query parameters for page number and results per page, as well as response headers that provide pagination metadata.

```http
GET /{resource}?page=1&per_page=50 HTTP/1.1
X-Total: 1
X-Total-Pages: 1
X-Per-Page: 50
X-Page: 1
```

--------------------------------

### Money Transfer API v2 - Getting Started Flow

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

This section outlines the typical flow for sending a transaction using the Money Transfer API v2. It includes the sequence of API endpoints to be called for a successful transaction.

```APIDOC
## Money Transfer API v2 - Getting Started Flow

### Description
This outlines the typical flow for sending a transaction using the Money Transfer API v2, including the sequence of API endpoints to be called.

### Method
GET, POST

### Endpoint
- `/v2/money-transfer/payers`
- `/v2/money-transfer/payers/{id}/{transaction_type}/credit-party-information`
- `/v2/money-transfer/payers/{id}/{transaction_type}/credit-party-verification`
- `/v2/money-transfer/quotations`
- `/v2/money-transfer/quotations/{quotation_id}/transactions`
- `/v2/money-transfer/transactions/{id}/confirm`
- `/v2/money-transfer/transactions/{transaction_id}`

### Sequence
1. **Get the list of payers:**
   `GET /payers`
2. **Optional Beneficiary Account Validation:**
   `POST /payers/{id}/{transaction_type}/credit-party-information`
   `POST /payers/{id}/{transaction_type}/credit-party-verification`
3. **Create a Quotation:**
   `POST /quotations` (to get fees and FX rate)
4. **Create a Transaction:**
   `POST /quotations/{quotation_id}/transactions` (to submit sender and beneficiary details)
5. **Confirm the Transaction:**
   `POST /transactions/{id}/confirm` (to dispatch the transaction)
6. **Get Transaction Status:**
   `GET /transactions/{transaction_id}`

### Base URL
`/v2/money-transfer`
```

--------------------------------

### Create a Quotation - Response Body Example

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Example JSON response when a quotation is successfully created. It includes the quotation ID, payer details, transaction specifics, source and destination amounts, FX rate, fees, and validity dates.

```json
{
    "id": 1,
    "external_id": "1481184321405",
    "payer": {
        "id": 1,
        "name": "Sample Payer",
        "currency": "USD",
        "country_iso_code": "ZWE",
        "service": {
            "id": 1,
            "name": "MobileWallet"
        }
    },
    "mode": "SOURCE_AMOUNT",
    "transaction_type": "C2C",
    "source": {
        "country_iso_code": "FRA",
        "currency": "EUR",
        "amount": 10
    },
    "destination": {
        "currency": "USD",
        "amount": 10.69
    },
    "sent_amount": {
        "currency": "EUR",
        "amount": 10
    },
    "wholesale_fx_rate": 1.06891969534071,
    "fee": {
        "currency": "EUR",
        "amount": 1.88
    },
    "creation_date": "2016-11-02T09:07:44",
    "expiration_date": "2016-11-03T09:07:44"
}
```

--------------------------------

### Create a Quotation - Request Body Example

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Example JSON payload for creating a quotation. This specifies the source amount and currency, and the desired destination currency. The API will calculate the equivalent destination amount.

```json
{
    "external_id": "1481184321405",
    "payer_id": "1",
    "mode": "SOURCE_AMOUNT",
    "transaction_type": "C2C",
    "source": {
        "amount": "10",
        "currency": "EUR",
        "country_iso_code": "FRA"
    },
    "destination": {
        "amount": null,
        "currency": "USD"
    }
}
```

--------------------------------

### Getting Started: Transaction Flow

Source: https://docs.thunes.com/money-transfer/v2/index

The typical flow to send a transaction using the Thunes Money Transfer API involves several steps, from getting payer information to confirming the transaction.

```APIDOC
## Getting Started: Transaction Flow

This section outlines the typical steps to send a transaction using the Money Transfer API.

### Step 1: Get Payer Information

**Endpoint:** `GET /payers`

**Description:** Retrieves a list of available payers.

### Step 1.1: Beneficiary Account Validation (Optional)

**Endpoint:** `POST /payers/{id}/{transaction_type}/credit-party-information` or `POST /payers/{id}/{transaction_type}/credit-party-verification`

**Description:** Optionally validate beneficiary account details before proceeding with the transaction.

### Step 2: Create Quotation

**Endpoint:** `POST /quotations`

**Description:** Creates a quotation to obtain the applicable fees and foreign exchange (FX) rate for a transfer.

### Step 3: Create Transaction

**Endpoint:** `POST /quotations/{quotation_id}/transactions`

**Description:** Submits sender and beneficiary details to create a transaction based on an existing quotation.

### Step 4: Confirm Transaction

**Endpoint:** `POST /transactions/{id}/confirm`

**Description:** Confirms the transaction, initiating its dispatch through the Thunes network.

### Step 5: Get Transaction Status

**Endpoint:** `GET /transactions/{transaction_id}`

**Description:** Retrieves the current status of a specific transaction.

### Base URL

`/v2/money-transfer`
```

--------------------------------

### HTTP 401 Unauthorized Response Example

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Provides an example of an HTTP 401 Unauthorized response, indicating that credentials are missing or invalid. The response body contains an error object with a specific code and message.

```http
HTTP/1.1 401 Unauthorized
```

```json
{
  "errors": [
    {
      "code": "1000401",
      "message": "Unauthorized"
    }
  ]
}
```

--------------------------------

### GET /v2/money-transfer/services

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Retrieves a list of all available services for money transfers.

```APIDOC
## GET /v2/money-transfer/services

### Description
Retrieves a list of all services available to the caller.

### Method
GET

### Endpoint
/v2/money-transfer/services

### Parameters
#### Query Parameters
- **page** (Integer) - Optional - Page number.
- **per_page** (Integer) - Optional - Number of results per page (default 50, max 100).
- **country_iso_code** (String) - Optional - Country code in ISO 3166-1 alpha-3 format.

### Request Example
```json
{
  "example": "GET /v2/money-transfer/services HTTP/1.1"
}
```

### Response
#### Success Response (200 OK)
An array of service objects in a paginated fashion.

#### Response Example
```json
[
   {
      "id": 1,
      "name": "MobileWallet"
   },
   {
      "id": 2,
      "name": "BankAccount"
   },
   {
      "id": 3,
      "name": "CashPickup"
   }
]
```
```

--------------------------------

### GET /v2/money-transfer/balances

Source: https://docs.thunes.com/money-transfer/v2/index

Retrieve information for all account balances per currency.

```APIDOC
## GET /v2/money-transfer/balances

### Description
Retrieve information for all account balances per currency.
`available` = `balance` - `pending` + `credit_facility`

### Method
GET

### Endpoint
/v2/money-transfer/balances

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number.
- **per_page** (integer) - Optional - Number of results per page (default 50, max 100).

### Response
#### Success Response (200)
- Array of balance objects.
  - **id** (integer) - The balance ID.
  - **currency** (string) - The currency code (ISO 4217).
  - **balance** (integer) - The total balance.
  - **pending** (integer) - The pending balance.
  - **available** (integer) - The available balance.
  - **credit_facility** (integer) - The credit facility amount.

### Response Example
```json
[
    {
        "id": 1,
        "currency": "EUR",
        "balance": 10000000,
        "pending": 0,
        "available": 10000000,
        "credit_facility": 0
    }
]
```
```

--------------------------------

### GET /websites/thunes_money-transfer_v2/balance

Source: https://docs.thunes.com/money-transfer/v2/index

Retrieves the current account balance for a given currency, including available, pending, and credit facility information.

```APIDOC
## GET /websites/thunes_money-transfer_v2/balance

### Description
Retrieves the current account balance for a given currency, including available, pending, and credit facility information.

### Method
GET

### Endpoint
/websites/thunes_money-transfer_v2/balance

### Parameters
#### Query Parameters
- **currency** (string) - Required - The currency for which to retrieve the balance (e.g., EUR).

### Response
#### Success Response (200)
- **id** (Integer) - Balance ID.
- **currency** (String) - Currency in ISO 4217 format.
- **balance** (Number) - Current balance.
- **pending** (Number) - Amount in transit.
- **available** (Number) - Available amount for transacting.
- **credit_facility** (Number) - Credit facility.

#### Response Example
```json
{
  "id": 1,
  "currency": "EUR",
  "balance": 10000000,
  "pending": 0,
  "available": 10000000,
  "credit_facility": 0
}
```
```

--------------------------------

### Balance Topup Instruction JSON Example

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Defines the instructions required to top up a balance. This includes detailed bank account information for the recipient, such as account numbers, IBAN, bank name, and SWIFT code.

```json
{
  "account_code": "GT_XOF1234",
  "account_number": "AA0000000000000000000000",
  "account_name": "Sample account name",
  "iban": "CI00CI0000000000000000000000",
  "account_address": "Account address",
  "local_account_identifier_type": null,
  "local_account_identifier": "",
  "bank_name": "Sample bank",
  "bank_address": "Bank address",
  "swift_code": "ABCDEFGH",
  "local_code_type": null,
  "local_code": null,
  "intermediary_bank_name": null,
  "intermediary_bank_swift_code": null,
  "correspondant_code": null,
  "update_date": "2022-12-01T16:28:03Z",
  "creation_date": "2022-12-01T16:28:03Z"
}
```

--------------------------------

### Simulate Transaction: Created to Rejected

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

This example illustrates simulating a transaction's lifecycle from 'CREATED' to 'REJECTED-INVALID-BENEFICIARY'. It shows two possible paths: one directly simulating the rejection, and another involving confirmation followed by simulation of rejection.

```http
POST /v2/money-transfer/quotations HTTP/1.1
201 Created

```

```http
POST /v2/money-transfer/quotations/{quotation_id}/transactions HTTP/1.1
201 Created

```

```http
GET /v2/simulation/transactions/{transaction_id}/REJECTED-INVALID-BENEFICIARY HTTP/1.1
200 OK

```

```http
POST /v2/money-transfer/quotations HTTP/1.1
201 Created

```

```http
POST /v2/money-transfer/quotations/{quotation_id}/transactions HTTP/1.1
201 Created

```

```http
POST /v2/money-transfer/transactions/{transaction_id}/confirm HTTP/1.1
200 OK

```

```http
GET /v2/simulation/transactions/{transaction_id}/REJECTED-INVALID-BENEFICIARY HTTP/1.1
200 OK

```

--------------------------------

### GET /v2/money-transfer/balances/{balance_id}/topup_instructions

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Retrieves instructions on how to top up a specific balance. This endpoint provides necessary details like account numbers and bank information required for fund transfers.

```APIDOC
## GET /v2/money-transfer/balances/{balance_id}/topup_instructions

### Description
Retrieve information for balance topup instructions for `{balance_id}` provided. Balance ID can be retrieved from Balances API.

### Method
GET

### Endpoint
/v2/money-transfer/balances/{balance_id}/topup_instructions

### Parameters
No specific query parameters for this endpoint.

### Request Example
```
GET /v2/money-transfer/balances/1/topup_instructions HTTP/1.1
Host: api.thunes.com
Authorization: Bearer YOUR_API_KEY
```

### Response
#### Success Response (200)
- **account_code** (string) - The account code for top-up.
- **account_number** (string) - The account number for top-up.
- **account_name** (string) - The name associated with the account.
- **iban** (string) - The International Bank Account Number.
- **account_address** (string) - The address of the account holder.
- **local_account_identifier_type** (string) - The type of local account identifier (if applicable).
- **local_account_identifier** (string) - The local account identifier (if applicable).
- **bank_name** (string) - The name of the bank.
- **bank_address** (string) - The address of the bank.
- **swift_code** (string) - The SWIFT code of the bank.
- **local_code_type** (string) - The type of local code (if applicable).
- **local_code** (string) - The local code (if applicable).
- **intermediary_bank_name** (string) - The name of the intermediary bank (if applicable).
- **intermediary_bank_swift_code** (string) - The SWIFT code of the intermediary bank (if applicable).
- **correspondant_code** (string) - The correspondent bank code (if applicable).
- **update_date** (Datetime) - The date and time when the top-up instructions were last updated.
- **creation_date** (Datetime) - The date and time when the top-up instructions were created.

#### Response Example
```json
{
   "account_code": "GT_XOF1234",
   "account_number": "AA0000000000000000000000",
   "account_name": "Sample account name",
   "iban": "CI00CI0000000000000000000000",
   "account_address": "Account address",
   "local_account_identifier_type": null,
   "local_account_identifier": "",
   "bank_name": "Sample bank",
   "bank_address": "Bank address",
   "swift_code": "ABCDEFGH",
   "local_code_type": null,
   "local_code": null,
   "intermediary_bank_name": null,
   "intermediary_bank_swift_code": null,
   "correspondant_code": null,
   "update_date": "2022-12-01T16:28:03Z",
   "creation_date": "2022-12-01T16:28:03Z"
}
```
```

--------------------------------

### GET /v2/money-transfer/reports/{report_id}/files/{id}

Source: https://docs.thunes.com/money-transfer/v2/index

Get details for a specific report file, including a signed URL for download.

```APIDOC
## GET /v2/money-transfer/reports/{report_id}/files/{id}

### Description
Retrieve information for a given report file, It will return signed URL to download the file contents. The report id and file id must be supplied replacing {report_id} and {id} in the URI path respectively.

### Method
GET

### Endpoint
/v2/money-transfer/reports/{report_id}/files/{id}

### Parameters
#### Path Parameters
- **report_id** (string) - Required - The ID of the report.
- **id** (string) - Required - The ID of the report file.

### Response
#### Success Response (200)
- **url** (string) - A signed URL to download the file.

### Response Example
```json
{
  "url": "<Signed URL>"
}
```
```

--------------------------------

### Retrieve a Quotation by ID - Response Body Example

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Example JSON response when retrieving a quotation by its ID. The structure is identical to the creation response, providing all details of the specified quotation.

```json
{
    "id": 1,
    "external_id": "1481184321405",
    "payer": {
        "id": 1,
        "name": "Sample Payer",
        "precision": 2,
        "increment": 0.01,
        "currency": "USD",
        "country_iso_code": "ZWE",
        "service": {
            "id": 1,
            "name": "MobileWallet"
        }
    },
    "mode": "SOURCE_AMOUNT",
    "transaction_type": "C2C",
    "source": {
        "country_iso_code": "FRA",
        "currency": "EUR",
        "amount": 10
    },
    "destination": {
        "currency": "USD",
        "amount": 10.69
    },
    "sent_amount": {
        "currency": "EUR",
        "amount": 10
    },
    "wholesale_fx_rate": 1.06891969534071,
    "fee": {
        "currency": "EUR",
        "amount": 1.88
    },
    "creation_date": "2016-11-02T09:07:44",
    "expiration_date": "2016-11-03T09:07:44"
}
```

--------------------------------

### Balance Topup Instruction

Source: https://docs.thunes.com/money-transfer/v2/index

Retrieves instructions for topping up a balance, including account details, bank information, and relevant codes.

```APIDOC
## Balance Topup Instruction

### Description
Represents a balance topup instruction for a given balance id.

### Method
GET

### Endpoint
`/websites/thunes_money-transfer_v2/balance-topup-instruction/{balance_id}`

### Parameters
#### Path Parameters
- **balance_id** (String) - Required - The identifier of the balance for which to retrieve top-up instructions.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **account_code** (String) - Account code
- **account_number** (String) - Bank account number
- **iban** (String) - Bank account number in IBAN format
- **account_address** (String) - Account address
- **local_account_identifier_type** (String) - Local Account Identifier Type
- **local_account_identifier** (String) - Value of the local account identifer
- **bank_name** (String) - Bank name
- **bank_address** (String) - Bank address
- **swift_code** (String) - SWIFT-BIC code
- **local_code_type** (String) - Local Code Type
- **local_code** (String) - Value of the local code
- **intermediary_bank_name** (String) - Intermediary bank name
- **intermediary_bank_swift_code** (String) - Intermediary bank SWIFT code
- **correspondant_code** (String) - Correspondant code
- **creation_date** (String) - Creation date in HTTP format
- **update_date** (String) - Update date in HTTP format

#### Response Example
```json
{
  "account_code": "GT_XOF1234",
  "account_number": "AA0000000000000000000000",
  "account_name": "Sample account name",
  "iban": "CI00CI0000000000000000000000",
  "account_address": "Account address",
  "local_account_identifier_type": null,
  "local_account_identifier": "",
  "bank_name": "Sample bank",
  "bank_address": "Bank address",
  "swift_code": "ABCDEFGH",
  "local_code_type": null,
  "local_code": null,
  "intermediary_bank_name": null,
  "intermediary_bank_swift_code": null,
  "correspondant_code": null,
  "update_date": "2022-12-01T16:28:03Z",
  "creation_date": "2022-12-01T16:28:03Z"
}
```
```

--------------------------------

### Retrieve Balance Topup Instructions

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Fetches top-up instructions for a specific balance ID. This includes account details required for transferring funds into the balance. The Balance ID can be obtained from the Balances API.

```HTTP
GET /v2/money-transfer/balances/1/topup_instructions HTTP/1.1
200 OK
```

```JSON
{
   "account_code": "GT_XOF1234",
   "account_number": "AA0000000000000000000000",
   "account_name": "Sample account name",
   "iban": "CI00CI0000000000000000000000",
   "account_address": "Account address",
   "local_account_identifier_type": null,
   "local_account_identifier": "",
   "bank_name": "Sample bank",
   "bank_address": "Bank address",
   "swift_code": "ABCDEFGH",
   "local_code_type": null,
   "local_code": null,
   "intermediary_bank_name": null,
   "intermediary_bank_swift_code": null,
   "correspondant_code": null,
   "update_date": "2022-12-01T16:28:03Z",
   "creation_date": "2022-12-01T16:28:03Z"
}
```

--------------------------------

### GET /ping

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Checks the API status and connectivity.

```APIDOC
## GET /ping

### Description
Query API status and check connectivity.

### Method
GET

### Endpoint
/ping

### Parameters
None

### Request Example
```json
{
  "example": "GET /ping HTTP/1.1"
}
```

### Response
#### Success Response (200 OK)
- **status** (String) - API status. Expected value is "up".

#### Response Example
```json
{
   "status": "up"
}
```
```

--------------------------------

### Callback HTTP Request Example (HTTP)

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

This snippet shows the structure of an HTTP POST request sent to a callback URL, including headers and the JSON payload for transaction status updates. The `Content-Type` should be `application/json`.

```http
POST /callback HTTP/1.1
Date: Wed, 02 Nov 2016 09:17:54 GMT
Content-Type: application/json
```

--------------------------------

### Simulate Transaction: Created to Declined

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

This scenario demonstrates simulating a transaction that moves from 'CREATED' to a 'DECLINED-INVALID-BENEFICIARY-DETAILS' state. The process includes creating a quotation, initiating the transaction, confirming it, and then simulating the decline status.

```http
POST /v2/money-transfer/quotations HTTP/1.1
201 Created

```

```http
POST /v2/money-transfer/quotations/{quotation_id}/transactions HTTP/1.1
201 Created

```

```http
POST /v2/money-transfer/transactions/{transaction_id}/confirm HTTP/1.1
200 OK

```

```http
GET /v2/simulation/transactions/{transaction_id}/DECLINED-INVALID-BENEFICIARY-DETAILS HTTP/1.1
200 OK

```

--------------------------------

### Basic Authentication with cURL

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Demonstrates how to authenticate API requests using basic authentication with cURL. It requires an API key and API secret, which should be kept secure and not exposed in source code. Environment variables or vault mechanisms are recommended for storing credentials.

```curl
curl https://${API_ENDPOINT}/ping \
  -u "${API_KEY}:${API_SECRET}"
```

--------------------------------

### Simulate Transaction: Created to Rejected Invalid Beneficiary (Two Paths)

Source: https://docs.thunes.com/money-transfer/v2/index

This scenario shows two distinct paths to simulate a money transfer transaction from CREATED to REJECTED-INVALID-BENEFICIARY. One path involves creating a quotation, transaction, and directly simulating the rejected status, while the other includes confirming the transaction before simulating the rejected status.

```HTTP
POST /v2/money-transfer/quotations HTTP/1.1
201 Created

POST /v2/money-transfer/quotations/{quotation_id}/transactions HTTP/1.1
201 Created

GET /v2/simulation/transactions/{transaction_id}/REJECTED-INVALID-BENEFICIARY HTTP/1.1
200 OK
```

```HTTP
POST /v2/money-transfer/quotations HTTP/1.1
201 Created

POST /v2/money-transfer/quotations/{quotation_id}/transactions HTTP/1.1
201 Created

POST /v2/money-transfer/transactions/{transaction_id}/confirm HTTP/1.1
200 OK

GET /v2/simulation/transactions/{transaction_id}/REJECTED-INVALID-BENEFICIARY HTTP/1.1
200 OK
```

--------------------------------

### GET /v2/money-transfer/transactions/{id}

Source: https://docs.thunes.com/money-transfer/v2/index

Retrieve detailed information about a specific transaction using its unique identifier.

```APIDOC
## GET /v2/money-transfer/transactions/{id}

### Description
Retrieve information for a given transaction. The id of the transaction must be supplied replacing `{id}` in the URI path.

### Method
GET

### Endpoint
/v2/money-transfer/transactions/{id}

#### Path Parameters
- **id** (integer) - Required - The unique identifier of the transaction.

### Request Example
```
GET /v2/money-transfer/transactions/1 HTTP/1.1
Host: api.thunes.com
Authorization: Bearer YOUR_ACCESS_TOKEN
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the transaction.
- **status** (string) - The current status code of the transaction.
- **status_message** (string) - A human-readable message describing the transaction status.
- **status_class** (string) - The status class code.
- **status_class_message** (string) - A human-readable message describing the status class.
- **external_id** (string) - The external identifier for the transaction.
- **external_code** (string) - An external code associated with the transaction.
- **transaction_type** (string) - The type of transaction (e.g., 'C2C').
- **payer_transaction_reference** (string) - The payer's transaction reference.
- **payer_transaction_code** (string) - The payer's transaction code.
- **creation_date** (string) - The date and time when the transaction was created (ISO 8601 format).
- **expiration_date** (string) - The date and time when the transaction expires (ISO 8601 format).
- **credit_party_identifier** (object) - Details of the credit party.
  - **msisdn** (string) - Mobile Station International Number.
  - **bank_account_number** (string) - Bank account number.
  - **swift_bic_code** (string) - SWIFT Business Identifier Code.
- **source** (object) - Details of the transaction source.
  - **country_iso_code** (string) - ISO 3166-1 alpha-3 country code of the source.
  - **currency** (string) - The currency code (ISO 4217) of the source amount.
  - **amount** (number) - The amount of the transaction from the source.
- **destination** (object) - Details of the transaction destination.
  - **currency** (string) - The currency code (ISO 4217) of the destination amount.
  - **amount** (number) - The amount of the transaction to the destination.
- **payer** (object) - Details of the payer.
  - **id** (integer) - The identifier of the payer.
  - **name** (string) - The name of the payer.
  - **currency** (string) - The currency code (ISO 4217) used by the payer.
  - **country_iso_code** (string) - ISO 3166-1 alpha-3 country code of the payer.
  - **service** (object) - Details of the payer's service.
    - **id** (integer) - The identifier of the service.
    - **name** (string) - The name of the service.
- **sender** (object) - Details of the sender.
  - **lastname** (string) - Sender's last name.
  - **lastname2** (string) - Sender's second last name.
  - **middlename** (string) - Sender's middle name.
  - **firstname** (string) - Sender's first name.
  - **nativename** (string) - Sender's name in native script.
  - **nationality_country_iso_code** (string) - ISO 3166-1 alpha-3 country code of sender's nationality.
  - **code** (string) - Sender's code.
  - **date_of_birth** (string) - Sender's date of birth (YYYY-MM-DD).
  - **country_of_birth_iso_code** (string) - ISO 3166-1 alpha-3 country code of sender's place of birth.
  - **gender** (string) - Sender's gender.
  - **address** (string) - Sender's address.
  - **postal_code** (string) - Sender's postal code.
  - **city** (string) - Sender's city.
  - **country_iso_code** (string) - ISO 3166-1 alpha-3 country code of sender's country.
  - **msisdn** (string) - Sender's mobile number.
  - **email** (string) - Sender's email address.
  - **id_type** (string) - Type of identification document.
  - **id_country_iso_code** (string) - ISO 3166-1 alpha-3 country code of the ID issuing country.
  - **id_number** (string) - Sender's identification number.
  - **id_delivery_date** (string) - Date of delivery for the identification document (YYYY-MM-DD).
  - **id_expiration_date** (string) - Expiration date for the identification document (YYYY-MM-DD).
  - **occupation** (string) - Sender's occupation.
  - **province_state** (string) - Sender's province or state.
  - **beneficiary_relationship** (string) - Relationship to the beneficiary.
  - **source_of_funds** (string) - Source of funds for the transaction.
  - **bank_account_number** (string) - Sender's bank account number.
- **beneficiary** (object) - Details of the beneficiary.
  - **lastname** (string) - Beneficiary's last name.
  - **lastname2** (string) - Beneficiary's second last name.
  - **middlename** (string) - Beneficiary's middle name.
  - **firstname** (string) - Beneficiary's first name.
  - **nativename** (string) - Beneficiary's name in native script.
  - **nationality_country_iso_code** (string) - ISO 3166-1 alpha-3 country code of beneficiary's nationality.
  - **code** (string) - Beneficiary's code.
  - **date_of_birth** (string) - Beneficiary's date of birth (YYYY-MM-DD).
  - **country_of_birth_iso_code** (string) - ISO 3166-1 alpha-3 country code of beneficiary's place of birth.
  - **gender** (string) - Beneficiary's gender.
  - **address** (string) - Beneficiary's address.
  - **postal_code** (string) - Beneficiary's postal code.
  - **city** (string) - Beneficiary's city.
  - **country_iso_code** (string) - ISO 3166-1 alpha-3 country code of beneficiary's country.
  - **msisdn** (string) - Beneficiary's mobile number.
  - **email** (string) - Beneficiary's email address.
  - **id_type** (string) - Type of identification document.
  - **id_country_iso_code** (string) - ISO 3166-1 alpha-3 country code of the ID issuing country.
  - **id_number** (string) - Beneficiary's identification number.
  - **id_delivery_date** (string) - Date of delivery for the identification document (YYYY-MM-DD).
  - **id_expiration_date** (string) - Expiration date for the identification document (YYYY-MM-DD).
  - **occupation** (string) - Beneficiary's occupation.
  - **bank_account_holder_name** (string) - Beneficiary's bank account holder name.
  - **province_state** (string) - Beneficiary's province or state.
- **callback_url** (string) - URL for receiving transaction status updates.
- **sent_amount** (object) - Details of the amount sent.
  - **currency** (string) - The currency code (ISO 4217) of the sent amount.
  - **amount** (number) - The amount sent.
- **wholesale_fx_rate** (number) - The wholesale foreign exchange rate.
- **retail_rate** (number) - The retail foreign exchange rate.
- **retail_fee** (number) - The retail fee amount.
- **retail_fee_currency** (string) - The currency code (ISO 4217) of the retail fee.
- **fee** (object) - Details of the transaction fee.
  - **currency** (string) - The currency code (ISO 4217) of the fee.
  - **amount** (number) - The amount of the fee.
- **purpose_of_remittance** (string) - The purpose of the remittance.
- **document_reference_number** (string) - Reference number for any associated documents.
- **additional_information_1** (string) - Additional information field 1.
- **additional_information_2** (string) - Additional information field 2.
- **additional_information_3** (string) - Additional information field 3.

#### Response Example
```json
{
     "id": 1,
     "status": "50000",
     "status_message": "SUBMITTED",
     "status_class": "5",
     "status_class_message": "SUBMITTED",
     "external_id": "1478078339357",
     "external_code": null,
     "transaction_type": "C2C",
     "payer_transaction_reference": null,
     "payer_transaction_code": null,
     "creation_date": "2016-11-02T09:19:15",
     "expiration_date": "2016-11-03T09:07:44",
     "credit_party_identifier": {
        "msisdn": "+263775892100",
        "bank_account_number": "0123456789",
        "swift_bic_code": "ABCDEFGH"
     },
     "source": {
        "country_iso_code": "FRA",
        "currency": "EUR",
        "amount": 10
     },
     "destination": {
        "currency": "USD",
        "amount": 10.69
     },
     "payer": {
        "id": 1,
        "name": "Sample Payer",
        "currency": "USD",
        "country_iso_code": "ZWE",
        "service": {
            "id": 1,
            "name": "MobileWallet"
        }
     },
     "sender": {
        "lastname": "Doe",
        "lastname2": null,
        "middlename": null,
        "firstname": "John",
        "nativename": null,
        "nationality_country_iso_code": "FRA",
        "code": null,
        "date_of_birth": "1970-01-01",
        "country_of_birth_iso_code": "FRA",
        "gender": "MALE",
        "address": "42 Rue des fleurs",
        "postal_code": "75000",
        "city": "Paris",
        "country_iso_code": "FRA",
        "msisdn": "33712345678",
        "email": "john.doe@mail.com",
        "id_type": "SOCIAL_SECURITY",
        "id_country_iso_code": null,
        "id_number": "502-42-0158",
        "id_delivery_date": "2016-01-01",
        "id_expiration_date": null,
        "occupation": "Residential Advisor",
        "province_state": null,
        "beneficiary_relationship": null,
        "source_of_funds": null,
        "bank_account_number": null
     },
     "beneficiary": {
        "lastname": "Doe",
        "lastname2": null,
        "middlename": null,
        "firstname": "Jane",
        "nativename": null,
        "nationality_country_iso_code": "FRA",
        "code": null,
        "date_of_birth": "1971-01-01",
        "country_of_birth_iso_code": "ZWE",
        "gender": "MALE",
        "address": "3 Norfolk Road",
        "postal_code": "4581",
        "city": "Harare",
        "country_iso_code": "ZWE",
        "msisdn": "263775892364",
        "email": "jane.doe@mail.com",
        "id_type": "SOCIAL_SECURITY",
        "id_country_iso_code": "ZWE",
        "id_number": "178027317681327",
        "id_delivery_date": null,
        "id_expiration_date": null,
        "occupation": "Sales Executive",
        "bank_account_holder_name": null,
        "province_state": null
     },
     "callback_url": "{URL_PLACEHOLDER}",
     "sent_amount": {
        "currency": "EUR",
        "amount": 10
     },
     "wholesale_fx_rate": 1.06891969534071,
     "retail_rate": null,
     "retail_fee": 1,
     "retail_fee_currency": "EUR",
     "fee": {
        "currency": "EUR",
        "amount": 1.88
     },
     "purpose_of_remittance": "FAMILY_SUPPORT",
     "document_reference_number": null,
     "additional_information_1": null,
     "additional_information_2": null,
     "additional_information_3": null
}
```

#### Error Response (404 Not Found)
Returned if the transaction with the specified ID is not found.

#### Error Response Example
```json
{
  "error": {
    "code": "TRANSACTION_NOT_FOUND",
    "message": "Transaction with ID 1 not found."
  }
}
```
```

--------------------------------

### Get Payer Details

Source: https://docs.thunes.com/money-transfer/v2/index_introduction

Retrieve detailed information for a specific payer using their unique ID.

```APIDOC
## GET /v2/money-transfer/payers/{id}

### Description
Retrieve information for a given payer. The payer id must be supplied replacing `{id}` in the URI path.

### Method
GET

### Endpoint
`/v2/money-transfer/payers/{id}`

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the payer.

### Response
#### Success Response (200)
- **id** (integer) - The payer's ID.
- **name** (string) - The payer's name.
- **precision** (integer) - Precision setting for currency.
- **increment** (number) - Increment value for currency.
- **currency** (string) - The currency associated with the payer (ISO 4217 format).
- **country_iso_code** (string) - The ISO 3166-1 alpha-3 code of the payer's country.
- **service** (object) - Details about the service used.
  - **id** (integer) - The service ID.
  - **name** (string) - The name of the service.
- **transaction_types** (object) - Configuration for different transaction types.
  - **C2C** (object) - Configuration for Credit-to-Credit transfers.
    - **minimum_transaction_amount** (number) - Minimum allowed transaction amount.
    - **maximum_transaction_amount** (number|null) - Maximum allowed transaction amount.
    - **credit_party_identifiers_accepted** (array) - Accepted identifiers for the credit party.
    - **required_sending_entity_fields** (array) - Required fields for the sending entity.
    - **required_receiving_entity_fields** (array) - Required fields for the receiving entity.
    - **required_documents** (array) - Documents required for the transaction.
    - **credit_party_information** (object) - Information related to the credit party.
      - **credit_party_identifiers_accepted** (array) - Accepted identifiers for the credit party.
    - **credit_party_verification** (object) - Verification details for the credit party.
      - **credit_party_identifiers_accepted** (array) - Accepted identifiers for the credit party.
      - **required_receiving_entity_fields** (array) - Required fields for the receiving entity.
    - **purpose_of_remittance_values_accepted** (array) - Accepted values for the purpose of remittance.

### Response Example
```json
{
    "id": 3,
    "name": "Sample Payer",
    "precision": 0,
    "increment": 0.01,
    "currency": "IDR",
    "country_iso_code": "IDN",
    "service": {
         "id": 1,
         "name": "MobileWallet"
    },
    "transaction_types": {
        "C2C": {
            "minimum_transaction_amount": 0,
            "maximum_transaction_amount": null,
            "credit_party_identifiers_accepted": [
                 [
                        "msisdn"
                 ]
            ],
            "required_sending_entity_fields": [
                 [
                        "firstname",
                        "date_of_birth",
                        "lastname"
                 ]
            ],
            "required_receiving_entity_fields": [
                 [
                        "firstname",
                        "lastname"
                 ]
            ],
            "required_documents": [
                [
                    "invoice",
                    "contract"
                ]
            ],
            "credit_party_information": {
                "credit_party_identifiers_accepted": [
                    []
                ]
            },
            "credit_party_verification": {
                "credit_party_identifiers_accepted": [
                    []
                ],
                "required_receiving_entity_fields": [
                    []
                ]
            },
            "purpose_of_remittance_values_accepted": [
            ]
        }
    }
}
```
```

--------------------------------

### Simulate Transaction Scenarios

Source: https://docs.thunes.com/money-transfer/v2/index

This section outlines how to simulate transaction lifecycles, from creation to various completed or declined states, using specific simulation endpoints.

```APIDOC
## Simulate Transaction

### Description
Simulate transaction status changes for testing purposes. This can be achieved by sending a header field `x-simulated-transaction: true` when creating a transaction, or by activating a global setting with your implementation manager.

### Methods
- **Create Quotation**: `POST /v2/money-transfer/quotations`
- **Create Transaction by Quotation**: `POST /v2/money-transfer/quotations/{quotation_id}/transactions`
- **Confirm Transaction**: `POST /v2/money-transfer/transactions/{transaction_id}/confirm`
- **Simulate Transaction Status Change**: `GET /v2/simulation/transactions/{transaction_id}/{status}`

### Example Scenarios

#### Example 1 (`CREATED` to `COMPLETED`)
1. `POST /v2/money-transfer/quotations`
2. `POST /v2/money-transfer/quotations/{quotation_id}/transactions`
3. `POST /v2/money-transfer/transactions/{transaction_id}/confirm`
4. `GET /v2/simulation/transactions/{transaction_id}/COMPLETED`

#### Example 2 (`CREATED` to `DECLINED-INVALID-BENEFICIARY-DETAILS`)
1. `POST /v2/money-transfer/quotations`
2. `POST /v2/money-transfer/quotations/{quotation_id}/transactions`
3. `POST /v2/money-transfer/transactions/{transaction_id}/confirm`
4. `GET /v2/simulation/transactions/{transaction_id}/DECLINED-INVALID-BENEFICIARY-DETAILS`

#### Example 3 (`CREATED` to `REJECTED-INVALID-BENEFICIARY`)
Option A:
1. `POST /v2/money-transfer/quotations`
2. `POST /v2/money-transfer/quotations/{quotation_id}/transactions`
3. `GET /v2/simulation/transactions/{transaction_id}/REJECTED-INVALID-BENEFICIARY`

Option B:
1. `POST /v2/money-transfer/quotations`
2. `POST /v2/money-transfer/quotations/{quotation_id}/transactions`
3. `POST /v2/money-transfer/transactions/{transaction_id}/confirm`
4. `GET /v2/simulation/transactions/{transaction_id}/REJECTED-INVALID-BENEFICIARY`

### Returns
Transaction object.
```
Tokens:
Raw