📖
Inyo Developer Portal
  • API REFERENCES
    • Payments Gateway v2
      • Getting started
      • Background
        • System architecture
        • Gateway environment settings
      • Authentication Methods
      • Environments
      • Technical Resources
      • Mitigating Fraud
      • APIs
        • Tokenizing cards
        • Payment
          • Pull Transaction
            • Handling AVS / CVC
            • Handling 3D secure
          • Push Transaction
          • Pull and push in one step
          • Capture
          • Refund
          • Void
          • Get a payment
          • Get a list
        • Webhooks
        • Domain tables
          • Response Code
          • Payment Status
        • Test data
          • Cards
    • Remittances
      • Getting Started
      • Authentication
      • Data Population
        • Country
        • State
        • Banks
        • Payers
        • Settlement Rates
      • Sender
        • Sender Object
        • Register a Sender
        • User Agreement
        • Get Sender by ID
        • Sender Verification
          • ID Documents
            • Expired ID Documents
          • KYC Status
          • KYC Using Widget
          • KYC Using API
            • Get KYC fields
            • Update KYC Information
            • Initiate KYC
            • Get KYC Information
          • Sender Tier Upgrade
        • Sender ID Information
      • Funding Account
        • Add Funding Account
          • OAuth Integration
        • Funding Account Object
        • Get Funding Account
        • Delete Funding Account
      • Recipient
        • Recipient Object
        • Add a Recipient
        • Get Recipient Details
        • Update Recipient
        • Recipient Document
      • Recipient Account
        • Recipient Account Object
        • Add a Recipient Account
        • Get Recipient Account
        • Get Account Information
      • Transaction
        • Transaction Object
        • Get Transaction Limits
        • Create a Transaction
          • 3DS Verification
          • Bonus/Discount
        • Get Transaction Details
        • Cancel Transaction
        • Delivery Request
        • Self-Payout
        • Transaction Invoice
      • Webhooks
        • Subscriptions
          • Subscribe
          • List Subscriptions
          • Pause Subscriptions
          • Remove Subscription
        • Integration
        • Events
      • Widget
        • Widget v1.0
          • Widget v1.0 Types
        • Widget v2.0
      • SANDBOX
        • Test Values
          • Geo-Fencing
          • Sender Verification
          • Funding Account
          • Transaction
  • USE CASE
    • Remittance
Powered by GitBook
On this page
  1. API REFERENCES
  2. Remittances
  3. Transaction

Self-Payout

Read on how to instructions for self-payout of transactions

PreviousDelivery RequestNextTransaction Invoice

Last updated 9 months ago

Once a transaction has been successfully created and has moved to pending state, you will be able to request for delivery through the . Upon receiving the delivery request, Machnet will verify if the transaction has passed all the compliance checks. Once all checks are completed, the delivery status will be changed to `DELIVERY_AUTHORIZED`.‘transaction_delivery_authorized’ webhook event will also be sent upon authorization.

Update Transaction Delivery Status

If you have an agreement with Inyo for self-payout, once you receive the authorization, the transaction can be paid out. Depending on the results of the payout, payout status needs to be updated using the below API.

POST /senders/{{senderId}}/transactions/{{transactionId}}/delivery-details

Parameter

Type

Required

Description

date_delivered

LocalDateTime

Yes

The time of delivery/ failure of payout

YYYY-MM-DD HH:MM:SS

e.g.2019-07-06 00:00:00

status

String

Yes

Delivery Status:

“DELIVERED”, “DELIVERY_FAILED”

note

String

Conditional

Note about the delivery.

1. Note is not

required in case the delivery is successful.

2. If the payout is not successful, you will need to update the failure reason in the note.

referenceNumber

String

No

Reference number of the Payout Partner

file

Base64

No

Proof of delivery may be required for transactions based on compliance requirements.

file_name

String

No

File name

curl -X POST {{url}}/senders/{{senderId}}/transactions/{{transactionId}}/delivery-details \
--header 'X-Client-Id: client_id' \
--header 'X-Client-Secret: client_secret' \
--header 'Content-Type: application/json' \
--data '{
    "date_delivered" : "2019-07-06 00:00:00",
    "status" : "delivery_status",
    "reference_number" : 5657575,
    "file_name" : "fileName.pdf",
    "file" : "base64 file"
}'
204
delivery-request API