Process Flow

The PAY API allows you to make a single Payment or multiple Payments by first creating a Batch.

Creating a Batch does not immediately initiate any Payments to users. Payments will only be made if the Batch is submitted for processing (shown below).

The typical flow to process Payment(s) is as follows:

  1. The process to make a Payment begins by calling POST /batches to create a payment Batch.

  2. 6DOT50 PAY creates the Batch (status will be in DRAFT) and returns a unique Batch id. This Batch id will be used to manage Payments in the Batch (e.g. add, delete), and ultimately will be used to submit the Batch for processing [6].

  3. Payments are added to the batch by calling POST /batches/{id}/payments, where {id} is the Batch id returned from [2]. This POST operation accepts an array of Payments, i.e. one or more Payments can be created for the Batch.

  4. Payments are created for the Batch and are all created in DRAFT status (i.e. not yet paid). A summary of the Payment(s) added to the Batch will be returned. Validation will also occur and any errors will be reported.

  5. Validate the Payments' return summary. Optionally create additional payments, or even delete any Payments in the Batch.

  6. Once ready to initiate Payment(s) to user(s): submit the Batch by calling the POST /batches/{id}/submit operation, where {id} is the Batch id.

  7. 6DOT50 will begin executing payment instructions from the Organisation's float Account for each Payment:

    1. If the Organisation does not have enough float to execute on all the Payments in the Batch, the Batch will remain in DRAFT and an error will be returned.

    2. If sufficient float exists: Payments will be made for each Payment in the Batch.

  8. A summary for the Batch will be returned which indicates the status of each Payment.

    1. If Payments in the Batch contained payments to existing 6DOT50 registered members only, the Batch status will immediately be set to CLOSED.

    2. If the Batch contains one or more Payments to non-6DOT50 members, the batch status will remain OPEN until such a time all Payments could be made.

  9. Users will be notified that a Payment has been made:

    1. If the user is a 6DOT50 member: they will be alerted via the 6DOT50 Mobile application by Push notification.

    2. If the user is a non-6DOT50 member: they will be sent an SMS notifying them that the Organisation has sent them a payment via 6DOT50 PAY. These users will be allocated their respective Payment(s) as soon as they register with 6DOT50.

  10. The Batch status will automatically be set to CLOSED when:

    1. All Payments in the Batch could be paid to users

    2. Payments that remain unclaimed by non-6DOT50 members are reversed at a configured Reversal Period

Reversal Period

By default, any Payments that were made to non-6DOT50 members and which remain unclaimed for a certain amount of time (the Reversal Period) are automatically reversed and paid back into the Organisation's PAY Account.

The Reversal Period can be configured within the 6DOT50 PAY Portal. The default period is 60 days.

Payments pending transfer to non-6DOT50 members are held within a holding account for the Organisation once a Batch is submitted for processing.

Unclaimed payments after the Reversal Period will be transferred from the holding account back to the Organisation's Account.

PreviousEndpointsNextRequests

Last updated