MAmasspay
User

All Users' Transactions history

Changed on

This GET endpoint is used to retrieve a list of all transactions, including payouts, loads, and spendbacks, for all users. <br> You can use this endpoint to obtain a comprehensive history of transactions for all users, allowing you to track and analyze their payment activities over time. <br> The response will contain a JSON array of transaction objects, each including transactions details.

get/payout/user/history

Request

Query parameters

number_of_recordsnumber

Number of records to return. Defaults to 10 if no value is provided

start_datestring date
Example:2020-03-31

Starting date

end_datestring date
Example:2020-03-31

Ending date

pageinteger

Page number

type'payout' | 'load' | 'spendback' | 'payin'
Example:payout

Filter particular types of transactions. Comma separated to include multiple types

wallet_tokenstring uuid

Filter transactions to include only provided wallet token.

show_all_clientsboolean

Whether to show transactions from all clients

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

Succesful operation.

tokenstring uuid required

Token represnting the transaction

type'load' | 'payout' | 'spend back' | 'info' | 'payin' required

Type of transaction

time_of_txnstring date-time required

Time of this history entry, in UTC. For most entries this is when the transaction was created; for the CANCELLED entry of a cancelled payout it is when the cancellation happened and the funds came back.

source_amountnumber float required

Source amount

source_currency_codestring required

The currency originating balance is stored in. Using ISO 4217 format. In most cases this value will be USD, and therefore the defaut value if none is provided

destination_amountnumber float required

The amount that was received in destination_currency_code

destination_currency_codestring required

The currency of the funds received. Using ISO 4217 format

feenumber float required

Fee of the transaction

status'PENDING' | 'EXPIRED' | 'PROCESSING' | 'COMPLETED' | 'CANCELLED' | 'SCHEDULED' | 'READY_FOR_PICKUP' | 'HOLD' | 'ERROR' | 'CANCELLED_AT_LATER_TIME' | 'RETURNED' required

Status of the transaction. A cancelled payout appears twice in the history: the original entry with CANCELLED_AT_LATER_TIME at the time it was created, and a second entry with CANCELLED at the time the cancellation happened and the funds came back. The payout itself has the single status CANCELLED, which is what the payout status endpoint and the payout webhook report.

notesstring

Notes of the transaction when load or spend back

payer_namestring

Name of the payer when payout transaction

pickup_codestring

Code/pin that is required when collecting the money when payout transaction

source_tokenstring uuid

Token that represents the funding source i.e. bank account, wallet. 36 characters long

destination_tokenstring uuid required

Token that represents the payout destination i.e. MassPay->Brazil->Bank Deposit->Itau. To be retrieved from the #pricing callback. If not provided, the last destination that was used for this user will be used. 36 characters long

delivery_type'CASH_PICKUP' | 'BANK_DEPOSIT' | 'HOME_DELIVERY' | 'MOBILE_WALLET' | 'MASSPAY_CARD' | 'PAPER_CHECK' | 'BILL' | 'CRYPTOCURRENCY'

The type of service. I.e. cash pickup, home delivery, etc. Only provided for payouts

client_transfer_idstring

A client defined transfer identifier. This is the unique ID assigned to the transfer on your system. Max 50 characters. A value another payout of yours already carries is rejected with 400 Bad request and Duplicate client id. Existing payout token: payout_<uuid> in error.details. By default a value becomes reusable once the earlier payout is ERROR or EXPIRED (or is a PENDING quote past its expiration); any other status, including CANCELLED, keeps it reserved. Accounts configured for strict uniqueness never allow reuse, whatever the earlier payout's status.

status_reasonstring

The reason for the status change. Usually would include reason for an ERROR or CANCEL status

client_idinteger

Optional client id

user_tokenstring

User token representing the user this transaction belongs to. For a payout initiated on behalf of a sender, the payee: such a payout is listed in the payee's history and in the sender's own, both times naming the payee here and the sender in sender_user_token.

destination_countrystring

3 letters ISO code for destination country

sender_user_tokenstring

Token that represents the user who is the sender (originator) of this payout, prefixed with usr_. Only returned for payout entries that were initiated on behalf of a sender (with a sender_user_token), in the payee's history as in the sender's own; absent when the client is the sender of record and for every other entry type.

sender_first_namestring

First name of the sender. Only returned together with sender_user_token.

sender_last_namestring

Last name of the sender. Only returned together with sender_user_token.

sender_business_namestring

Business name of the sender, when the sender is a business. Only returned together with sender_user_token.

Example response

[
  {
    "token": "123e4567-e89b-12d3-a456-426614174000",
    "type": "payout",
    "source_amount": 50.1,
    "source_currency_code": "USD",
    "destination_amount": 44.99,
    "fee": 2.98,
    "status": "READY_FOR_PICKUP",
    "notes": "Purchase of Candles. Order #14930",
    "payer_name": "Elektra",
    "pickup_code": "343432",
    "source_token": "123e4567-e89b-12d3-a456-426614174000",
    "destination_token": "123e4567-e89b-12d3-a456-426614174000",
    "sender_user_token": "usr_7f8e9d0c-1b2a-4c3d-9e5f-6a7b8c9d0e1f",
    "sender_first_name": "John",
    "sender_last_name": "Doe",
    "sender_business_name": "Acme Inc."
  }
]

Changes

  • f9fa41b7c45cRevision changes
    • warning

      added the new RETURNED enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status