Newline Platform API

Getting Started
Auth
- Generate an authentication tokenpost
Customers
Pools
- List Poolsget
- Get a single Poolget
Products
- List Productsget
- Get a single Productget
Customer Products
Custodial Accounts
Synthetic Accounts
Transfers
Sandbox
- Simulate a Transactionpost
Transactions
Debit Cards
Virtual Reference Numbers
Returns
Combined Transfers

Newline Platform API

Getting Started
Auth
- Generate an authentication tokenpost
Customers
Pools
- List Poolsget
- Get a single Poolget
Products
- List Productsget
- Get a single Productget
Customer Products
Custodial Accounts
Synthetic Accounts
Transfers
Sandbox
- Simulate a Transactionpost
Transactions
Debit Cards
Virtual Reference Numbers
Returns
Combined Transfers

Create a new Return

post https://sandbox.newline53.com/api/v1/returns

Initiate a Return of an ACH or wire payment. A full ACH addenda is not available for ACH returns because an addenda record is used for an ACH return; the addenda_info is the available remaining space in that record. Similarly, the wire_instruction provided here is limited to 70 characters because the instructions will be prefixed by Newline with the identifier (e.g IMAD) of the original wire transaction

Body Params

external_uid

string

Client supplied unique identifier. It must be unique within the customer. If the same value is given, no new resource will be created.

original_transaction_uid

string

required

The transaction to be returned.

requesting_customer_uid

string

required

The UID of the customer requesting a return.

requestor_type

string

required

Type of the customer requesting a return.

return_reason

string

required

Freeform text (up to 140 characters) documenting the reason for return.

ach

object

wire

object

Headers

x-trace-id

string

required

A unique identifier provided for each request. Duplicate values submitted in requests within 7 days of each other will cause the request to be rejected.

Responses

Response body

object

created_at

string

The DateTime at which this Return was created.

external_uid

string

Client supplied unique identifier. It must be unique within the customer. If the same value is given, no new resource will be created.

original_transaction_uid

string

The transaction to be returned.

customer_uid

string

The UID of the customer requesting a return.

requestor_type

string

Type of the customer requesting a return.

customer subclient

return_reason

string

Freeform text (up to 140 characters) documenting the reason for return.

return_transaction_uid

string

The transaction returning the funds.

status

string

A value indicating the overall status of the Return.

canceled queued pending settled failed

uid

string

Unique identifier for the Return

Headers

object

x-trace-id

string

The unique identifier provided with the request.

Response body

object

errors

array of objects

errors

object

code

integer

Code provided by Newline for reference

title

string

Title of Error Code

detail

string

Description of Error Code

occurred_at

string

Error Timestamp

extra

string

Included based on Error Code; Additional context to help users self-solve the error

status

integer

HTTP Status Code

Headers

object

x-trace-id

string

The unique identifier provided with the request.

Response body

object

created_at

string

The DateTime at which this Return was created.

external_uid

string

Client supplied unique identifier. It must be unique within the customer. If the same value is given, no new resource will be created.

original_transaction_uid

string

The transaction to be returned.

customer_uid

string

The UID of the customer requesting a return.

requestor_type

string

Type of the customer requesting a return.

customer subclient

return_reason

string

Freeform text (up to 140 characters) documenting the reason for return.

return_transaction_uid

string

The transaction returning the funds.

status

string

A value indicating the overall status of the Return.

canceled queued pending settled failed

uid

string

Unique identifier for the Return

Headers

object

x-trace-id

string

The unique identifier provided with the request.

Response body

object

errors

array of objects

errors

object

code

integer

Code provided by Newline for reference

title

string

Title of Error Code

detail

string

Description of Error Code

occurred_at

string

Error Timestamp

extra

string

Included based on Error Code; Additional context to help users self-solve the error

status

integer

HTTP Status Code

Headers

object

x-trace-id

string

The unique identifier provided with the request.

Updated 8 months ago

List Returns

Get a single Return

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.newline53.com/api/v1/returns \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "requestor_type": "customer"
8
}
9
'

Choose an example:

application/json

Updated 8 months ago

List Returns

Get a single Return

Did this page help you?

Newline Platform API
Getting Started
Auth
Generate an authentication tokenpost
Customers
Customer Statuses
Archive a Customerdelete
Adjust Customer Dataput
Get a single Customerget
Create a new Customerpost
Get a list of Customersget
Overview of Customer Types
Pools
Get a single Poolget
List Poolsget
Products
Get a single Productget
List Productsget
Customer Products
Customer Product Statuses
Get a single Customer Productget
Onboard Customer onto a Productpost
List Customer Productsget
Custodial Accounts
Custodial Account Statuses
Get a single Custodial Accountget
List Custodial Accountsget
Synthetic Accounts
Synthetic Account Statuses
Synthetic Account Categories
Archive a Synthetic Accountdelete
Update the Synthetic Account metadataput
Get a single Synthetic Accountget
Create a New Synthetic Accountpost
List Synthetic Accountsget
Get a Single Synthetic Account Typeget
List Synthetic Account Typesget
Transfers
Transfer Statuses
Cancel a Transferput
Get a single Transferget
Initiate a Transferpost
List Transfersget
Sandbox
Simulate a Transactionpost
Transactions
Debit Card Denied Authorization Reasons
Transaction Statuses and Types
Get a single Custodial Line Itemget
List Custodial Line Itemsget
Get a single Synthetic Line Itemget
List Synthetic Line Itemsget
Get a single Transaction Eventget
List Transaction Eventsget
Approve or deny a transactionput
Get a single Transactionget
List Transactionsget
Debit Cards
Get a virtual Debit Card imageget
Migrate a virtual Debit Card to a physical Debit Cardput
Get Debit Card access tokenget
Get Debit Card PIN tokenget
Reissue a Debit Cardput
Unlock a Debit Cardput
Lock a Debit Cardput
Activate a Debit Cardput
Get a single Debit Cardget
Create a new Debit Cardpost
List all Debit Cardsget
Virtual Reference Numbers
Virtual Reference Number Statuses
Unlock a single Virtual Reference Numberput
Lock a single Virtual Reference Numberput
Archive a single Virtual Reference Numberdelete
Edit a Virtual Reference Numberput
Get a single Virtual Reference Numberget
Create a new Virtual Reference Numberpost
List Virtual Reference Numbersget
Returns
Get a single Returnget
Create a new Returnpost
List Returnsget
Combined Transfers
Get a single Combined Transferget
Create a new Combined Transferpost
List Combined Transfersget

Newline Platform API
Getting Started
Auth
Generate an authentication tokenpost
Customers
Customer Statuses
Archive a Customerdelete
Adjust Customer Dataput
Get a single Customerget
Create a new Customerpost
Get a list of Customersget
Overview of Customer Types
Pools
Get a single Poolget
List Poolsget
Products
Get a single Productget
List Productsget
Customer Products
Customer Product Statuses
Get a single Customer Productget
Onboard Customer onto a Productpost
List Customer Productsget
Custodial Accounts
Custodial Account Statuses
Get a single Custodial Accountget
List Custodial Accountsget
Synthetic Accounts
Synthetic Account Statuses
Synthetic Account Categories
Archive a Synthetic Accountdelete
Update the Synthetic Account metadataput
Get a single Synthetic Accountget
Create a New Synthetic Accountpost
List Synthetic Accountsget
Get a Single Synthetic Account Typeget
List Synthetic Account Typesget
Transfers
Transfer Statuses
Cancel a Transferput
Get a single Transferget
Initiate a Transferpost
List Transfersget
Sandbox
Simulate a Transactionpost
Transactions
Debit Card Denied Authorization Reasons
Transaction Statuses and Types
Get a single Custodial Line Itemget
List Custodial Line Itemsget
Get a single Synthetic Line Itemget
List Synthetic Line Itemsget
Get a single Transaction Eventget
List Transaction Eventsget
Approve or deny a transactionput
Get a single Transactionget
List Transactionsget
Debit Cards
Get a virtual Debit Card imageget
Migrate a virtual Debit Card to a physical Debit Cardput
Get Debit Card access tokenget
Get Debit Card PIN tokenget
Reissue a Debit Cardput
Unlock a Debit Cardput
Lock a Debit Cardput
Activate a Debit Cardput
Get a single Debit Cardget
Create a new Debit Cardpost
List all Debit Cardsget
Virtual Reference Numbers
Virtual Reference Number Statuses
Unlock a single Virtual Reference Numberput
Lock a single Virtual Reference Numberput
Archive a single Virtual Reference Numberdelete
Edit a Virtual Reference Numberput
Get a single Virtual Reference Numberget
Create a new Virtual Reference Numberpost
List Virtual Reference Numbersget
Returns
Get a single Returnget
Create a new Returnpost
List Returnsget
Combined Transfers
Get a single Combined Transferget
Create a new Combined Transferpost
List Combined Transfersget

201A single registered Return is returned.

400Creation Error

403Denied access to Returns

422Creation Error